home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 1998 November / IRIX 6.5.2 Base Documentation November 1998.img / usr / share / catman / p_man / cat3 / Xm / XmFrame.z / XmFrame
Text File  |  1998-10-30  |  23KB  |  331 lines
  1.  
  2.  
  3.  
  4.      XXXXmmmmFFFFrrrraaaammmmeeee((((3333XXXX))))               UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV               XXXXmmmmFFFFrrrraaaammmmeeee((((3333XXXX))))
  5.  
  6.  
  7.  
  8.      NNNNAAAAMMMMEEEE
  9.           XXXXmmmmFFFFrrrraaaammmmeeee - The Frame widget class
  10.  
  11.      SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  12.           #include <Xm/Frame.h>
  13.  
  14.      VVVVEEEERRRRSSSSIIIIOOOONNNN
  15.           This page documents Motif 2.1.
  16.  
  17.      DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  18.           Frame is a very simple manager used to enclose a single work
  19.           area child in a border drawn by Frame.  It uses the Manager
  20.           class resources for border drawing and performs geometry
  21.           management so that its size always matches its child's outer
  22.           size plus the Frame's margins and shadow thickness.
  23.  
  24.           Frame is most often used to enclose other managers when the
  25.           application developer wants the manager to have the same
  26.           border appearance as the primitive widgets. Frame can also
  27.           be used to enclose primitive widgets that do not support the
  28.           same type of border drawing. This gives visual consistency
  29.           when you develop applications using diverse widget sets.
  30.           Constraint resources are used to designate a child as the
  31.           Frame title, align its text, and control its vertical
  32.           alignment in relation to Frame's top shadow. The title
  33.           appears only at the top of the Frame.
  34.  
  35.           If the Frame's parent is a Shell widget, the XXXXmmmmNNNNsssshhhhaaaaddddoooowwwwTTTTyyyyppppeeee
  36.           resource defaults to XXXXmmmmSSSSHHHHAAAADDDDOOOOWWWW____OOOOUUUUTTTT, and the Manager's
  37.           XXXXmmmmNNNNsssshhhhaaaaddddoooowwwwTTTThhhhiiiicccckkkknnnneeeessssssss resource defaults to 1.
  38.  
  39.           If the Frame's parent is not a Shell widget, the
  40.           XXXXmmmmNNNNsssshhhhaaaaddddoooowwwwTTTTyyyyppppeeee resouce defaults to XXXXmmmmSSSSHHHHAAAADDDDOOOOWWWW____EEEETTTTCCCCHHHHEEEEDDDD____IIIINNNN, and
  41.           the Manager's XXXXmmmmNNNNsssshhhhaaaaddddoooowwwwTTTThhhhiiiicccckkkknnnneeeessssssss resource defaults to 2.
  42.  
  43.         CCCCllllaaaasssssssseeeessss
  44.           Frame inherits behavior and resources from the CCCCoooorrrreeee,
  45.           CCCCoooommmmppppoooossssiiiitttteeee, CCCCoooonnnnssssttttrrrraaaaiiiinnnntttt, and XXXXmmmmMMMMaaaannnnaaaaggggeeeerrrr classes.
  46.  
  47.           The class pointer is _x_m_F_r_a_m_e_W_i_d_g_e_t_C_l_a_s_s.
  48.  
  49.           The class name is XXXXmmmmFFFFrrrraaaammmmeeee.
  50.  
  51.         NNNNeeeewwww RRRReeeessssoooouuuurrrrcccceeeessss
  52.           The following table defines a set of widget resources used
  53.           by the programmer to specify data. The programmer can also
  54.           set the resource values for the inherited classes to set
  55.           attributes for this widget. To reference a resource by name
  56.           or by class in a ....XXXXddddeeeeffffaaaauuuullllttttssss file, remove the XXXXmmmmNNNN or XXXXmmmmCCCC
  57.           prefix and use the remaining letters. To specify one of the
  58.           defined values for a resource in a ....XXXXddddeeeeffffaaaauuuullllttttssss file, remove
  59.           the XXXXmmmm prefix and use the remaining letters (in either
  60.  
  61.  
  62.  
  63.      Page 1                                         (printed 10/24/98)
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.      XXXXmmmmFFFFrrrraaaammmmeeee((((3333XXXX))))               UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV               XXXXmmmmFFFFrrrraaaammmmeeee((((3333XXXX))))
  71.  
  72.  
  73.  
  74.           lowercase or uppercase, but include any underscores between
  75.           words).  The codes in the access column indicate if the
  76.           given resource can be set at creation time (C), set by using
  77.           XXXXttttSSSSeeeettttVVVVaaaalllluuuueeeessss (S), retrieved by using XXXXttttGGGGeeeettttVVVVaaaalllluuuueeeessss (G), or is
  78.           not applicable (N/A).
  79.  
  80.                                   XXXXmmmmFFFFrrrraaaammmmeeee RRRReeeessssoooouuuurrrrcccceeee SSSSeeeetttt
  81.           NNNNaaaammmmeeee              CCCCllllaaaassssssss             TTTTyyyyppppeeee            DDDDeeeeffffaaaauuuulllltttt   AAAAcccccccceeeessssssss
  82.           XmNmarginWidth    XmCMarginWidth    Dimension       0         CSG
  83.           XmNmarginHeight   XmCMarginHeight   Dimension       0         CSG
  84.           XmNshadowType     XmCShadowType     unsigned char   dynamic   CSG
  85.  
  86.           XXXXmmmmNNNNmmmmaaaarrrrggggiiiinnnnWWWWiiiiddddtttthhhh
  87.                     Specifies the padding space on the left and right
  88.                     sides between Frame's child and Frame's shadow
  89.                     drawing.
  90.  
  91.           XXXXmmmmNNNNmmmmaaaarrrrggggiiiinnnnHHHHeeeeiiiigggghhhhtttt
  92.                     Specifies the padding space on the top and bottom
  93.                     sides between Frame's child and Frame's shadow
  94.                     drawing.  When a title is present, the top margin
  95.                     equals the value specified by this resource plus
  96.                     the distance (if any) that the title extends below
  97.                     the top shadow.
  98.  
  99.           XXXXmmmmNNNNsssshhhhaaaaddddoooowwwwTTTTyyyyppppeeee
  100.                     Describes the drawing style for Frame. This
  101.                     resource can have the following values:
  102.  
  103.                     XXXXmmmmSSSSHHHHAAAADDDDOOOOWWWW____IIIINNNN
  104.                               Draws Frame so that it appears inset.
  105.                               This means that the bottom shadow
  106.                               visuals and top shadow visuals are
  107.                               reversed.
  108.  
  109.                     XXXXmmmmSSSSHHHHAAAADDDDOOOOWWWW____OOOOUUUUTTTT
  110.                               Draws Frame so that it appears outset.
  111.                               This is the default if Frame's parent is
  112.                               a Shell widget.
  113.  
  114.                     XXXXmmmmSSSSHHHHAAAADDDDOOOOWWWW____EEEETTTTCCCCHHHHEEEEDDDD____IIIINNNN
  115.                               Draws Frame using a double line giving
  116.                               the effect of a line etched into the
  117.                               window. The thickness of the double line
  118.                               is equal to the value of
  119.                               XXXXmmmmNNNNsssshhhhaaaaddddoooowwwwTTTThhhhiiiicccckkkknnnneeeessssssss.  This is the default
  120.                               when Frame's parent is not a Shell
  121.                               widget.
  122.  
  123.                     XXXXmmmmSSSSHHHHAAAADDDDOOOOWWWW____EEEETTTTCCCCHHHHEEEEDDDD____OOOOUUUUTTTT
  124.                               Draws Frame using a double line giving
  125.                               the effect of a line coming out of the
  126.  
  127.  
  128.  
  129.      Page 2                                         (printed 10/24/98)
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136.      XXXXmmmmFFFFrrrraaaammmmeeee((((3333XXXX))))               UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV               XXXXmmmmFFFFrrrraaaammmmeeee((((3333XXXX))))
  137.  
  138.  
  139.  
  140.                               window. The thickness of the double line
  141.                               is equal to the value of
  142.                               XXXXmmmmNNNNsssshhhhaaaaddddoooowwwwTTTThhhhiiiicccckkkknnnneeeessssssss.
  143.  
  144.                                                 XXXXmmmmFFFFrrrraaaammmmeeee CCCCoooonnnnssssttttrrrraaaaiiiinnnntttt RRRReeeessssoooouuuurrrrcccceeee SSSSeeeetttt
  145.           NNNNaaaammmmeeee                          CCCCllllaaaassssssss                         TTTTyyyyppppeeee            DDDDeeeeffffaaaauuuulllltttt                  AAAAcccccccceeeessssssss
  146.           XmNchildType                  XmCChildType                  unsigned char   XmFRAME_WORKAREA_CHILD   CSG
  147.           XmNchildHorizontalAlignment   XmCChildHorizontalAlignment   unsigned char   XmALIGNMENT_BEGINNING    CSG
  148.           XmNchildHorizontalSpacing     XmCChildHorizontalSpacing     Dimension       dynamic                  CSG
  149.           XmNchildVerticalAlignment     XmCChildVerticalAlignment     unsigned char   XmALIGNMENT_CENTER       CSG
  150.           XmNframeChildType             XmCFrameChildType             unsigned char   XmFRAME_WORKAREA_CHILD   CSG
  151.  
  152.           XXXXmmmmNNNNcccchhhhiiiillllddddTTTTyyyyppppeeee
  153.                     Refer to the XXXXmmmmNNNNffffrrrraaaammmmeeeeCCCChhhhiiiillllddddTTTTyyyyppppeeee resource
  154.                     description. The XXXXmmmmNNNNcccchhhhiiiillllddddTTTTyyyyppppeeee resource is
  155.                     obsoleted by XXXXmmmmNNNNffffrrrraaaammmmeeeeCCCChhhhiiiillllddddTTTTyyyyppppeeee, but is kept here
  156.                     for backward compatibility.
  157.  
  158.           XXXXmmmmNNNNcccchhhhiiiillllddddHHHHoooorrrriiiizzzzoooonnnnttttaaaallllAAAAlllliiiiggggnnnnmmmmeeeennnntttt
  159.                     Specifies the alignment of the title. This
  160.                     resource has the following values:
  161.  
  162.                        +o  XXXXmmmmAAAALLLLIIIIGGGGNNNNMMMMEEEENNNNTTTT____BBBBEEEEGGGGIIIINNNNNNNNIIIINNNNGGGG
  163.  
  164.                        +o  XXXXmmmmAAAALLLLIIIIGGGGNNNNMMMMEEEENNNNTTTT____CCCCEEEENNNNTTTTEEEERRRR
  165.  
  166.                        +o  XXXXmmmmAAAALLLLIIIIGGGGNNNNMMMMEEEENNNNTTTT____EEEENNNNDDDD
  167.  
  168.                     See the description of XXXXmmmmNNNNaaaalllliiiiggggnnnnmmmmeeeennnntttt in the
  169.                     XXXXmmmmLLLLaaaabbbbeeeellllreference page for an explanation of these
  170.                     values.
  171.  
  172.           XXXXmmmmNNNNcccchhhhiiiillllddddHHHHoooorrrriiiizzzzoooonnnnttttaaaallllSSSSppppaaaacccciiiinnnngggg
  173.                     Specifies the minimum distance between either edge
  174.                     of the title text and the inner edge of the Frame
  175.                     shadow. Clipping of the title text occurs in order
  176.                     to maintain this spacing. The default value is the
  177.                     margin width of the Frame.
  178.  
  179.           XXXXmmmmNNNNcccchhhhiiiillllddddVVVVeeeerrrrttttiiiiccccaaaallllAAAAlllliiiiggggnnnnmmmmeeeennnntttt
  180.                     Specifies the vertical alignment of the title
  181.                     text, or the title area in relation to the top
  182.                     shadow of the Frame.
  183.  
  184.                     XXXXmmmmAAAALLLLIIIIGGGGNNNNMMMMEEEENNNNTTTT____BBBBAAAASSSSEEEELLLLIIIINNNNEEEE____BBBBOOOOTTTTTTTTOOOOMMMM
  185.                               Causes the baseline of the title to
  186.                               align vertically with the top shadow of
  187.                               the Frame. In the case of a multi-line
  188.                               title, the baseline of the last line of
  189.                               text aligns vertically with the top
  190.                               shadow of the Frame.
  191.  
  192.  
  193.  
  194.  
  195.      Page 3                                         (printed 10/24/98)
  196.  
  197.  
  198.  
  199.  
  200.  
  201.  
  202.      XXXXmmmmFFFFrrrraaaammmmeeee((((3333XXXX))))               UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV               XXXXmmmmFFFFrrrraaaammmmeeee((((3333XXXX))))
  203.  
  204.  
  205.  
  206.                     XXXXmmmmAAAALLLLIIIIGGGGNNNNMMMMEEEENNNNTTTT____BBBBAAAASSSSEEEELLLLIIIINNNNEEEE____TTTTOOOOPPPP
  207.                               Causes the baseline of the first line of
  208.                               the title to align vertically with the
  209.                               top shadow of the Frame.
  210.  
  211.                     XXXXmmmmAAAALLLLIIIIGGGGNNNNMMMMEEEENNNNTTTT____CCCCHHHHIIIILLLLDDDD____TTTTOOOOPPPP
  212.                               Causes the top edge of the title area to
  213.                               align vertically with the top shadow of
  214.                               the Frame.
  215.  
  216.                     XXXXmmmmAAAALLLLIIIIGGGGNNNNMMMMEEEENNNNTTTT____CCCCEEEENNNNTTTTEEEERRRR
  217.                               Causes the center of the title area to
  218.                               align vertically with the top shadow of
  219.                               the Frame.
  220.  
  221.                     XXXXmmmmAAAALLLLIIIIGGGGNNNNMMMMEEEENNNNTTTT____CCCCHHHHIIIILLLLDDDD____BBBBOOOOTTTTTTTTOOOOMMMM
  222.                               Causes the bottom edge of the title area
  223.                               to align vertically with the top shadow
  224.                               of the Frame.
  225.  
  226.           XXXXmmmmNNNNffffrrrraaaammmmeeeeCCCChhhhiiiillllddddTTTTyyyyppppeeee
  227.                     Specifies whether a child is a title or work area.
  228.                     Frame supports a single title and/or work area
  229.                     child. The possible values are
  230.  
  231.                        +o  XXXXmmmmFFFFRRRRAAAAMMMMEEEE____TTTTIIIITTTTLLLLEEEE____CCCCHHHHIIIILLLLDDDD
  232.  
  233.                        +o  XXXXmmmmFFFFRRRRAAAAMMMMEEEE____WWWWOOOORRRRKKKKAAAARRRREEEEAAAA____CCCCHHHHIIIILLLLDDDD
  234.  
  235.                        +o  XXXXmmmmFFFFRRRRAAAAMMMMEEEE____GGGGEEEENNNNEEEERRRRIIIICCCC____CCCCHHHHIIIILLLLDDDD
  236.  
  237.                     The Frame geometry manager ignores any child of
  238.                     type XXXXmmmmFFFFRRRRAAAAMMMMEEEE____GGGGEEEENNNNEEEERRRRIIIICCCC____CCCCHHHHIIIILLLLDDDD.  This resource
  239.                     replaces XXXXmmmmNNNNcccchhhhiiiillllddddTTTTyyyyppppeeee.
  240.  
  241.         IIIInnnnhhhheeeerrrriiiitttteeeedddd RRRReeeessssoooouuuurrrrcccceeeessss
  242.           Frame inherits behavior and resources from the following
  243.           superclasses. For a complete description of each resource,
  244.           refer to the reference page for that superclass.
  245.  
  246.                                                 XXXXmmmmMMMMaaaannnnaaaaggggeeeerrrr RRRReeeessssoooouuuurrrrcccceeee SSSSeeeetttt
  247.           NNNNaaaammmmeeee                      CCCCllllaaaassssssss                   TTTTyyyyppppeeee                DDDDeeeeffffaaaauuuulllltttt                AAAAcccccccceeeessssssss
  248.           XmNbottomShadowColor      XmCBottomShadowColor    Pixel               dynamic                CSG
  249.           XmNbottomShadowPixmap     XmCBottomShadowPixmap   Pixmap              XmUNSPECIFIED_PIXMAP   CSG
  250.           XmNforeground             XmCForeground           Pixel               dynamic                CSG
  251.           XmNhelpCallback           XmCCallback             XtCallbackList      NULL                   C
  252.           XmNhighlightColor         XmCHighlightColor       Pixel               dynamic                CSG
  253.           XmNhighlightPixmap        XmCHighlightPixmap      Pixmap              dynamic                CSG
  254.           XmNinitialFocus           XmCInitialFocus         Widget              NULL                   CSG
  255.           XmNlayoutDirection        XmCLayoutDirection      XmDirection         dynamic                CG
  256.  
  257.  
  258.  
  259.  
  260.  
  261.      Page 4                                         (printed 10/24/98)
  262.  
  263.  
  264.  
  265.  
  266.  
  267.  
  268.      XXXXmmmmFFFFrrrraaaammmmeeee((((3333XXXX))))               UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV               XXXXmmmmFFFFrrrraaaammmmeeee((((3333XXXX))))
  269.  
  270.  
  271.  
  272.           XmNnavigationType         XmCNavigationType       XmNavigationType    XmTAB_GROUP            CSG
  273.           XmNpopupHandlerCallback   XmCCallback             XtCallbackList      NULL                   C
  274.           XmNshadowThickness        XmCShadowThickness      Dimension           dynamic                CSG
  275.           XmNstringDirection        XmCStringDirection      XmStringDirection   dynamic                CG
  276.           XmNtopShadowColor         XmCTopShadowColor       Pixel               dynamic                CSG
  277.           XmNtopShadowPixmap        XmCTopShadowPixmap      Pixmap              dynamic                CSG
  278.           XmNtraversalOn            XmCTraversalOn          Boolean             True                   CSG
  279.           XmNunitType               XmCUnitType             unsigned char       dynamic                CSG
  280.           XmNuserData               XmCUserData             XtPointer           NULL                   CSG
  281.  
  282.                                   CCCCoooommmmppppoooossssiiiitttteeee RRRReeeessssoooouuuurrrrcccceeee SSSSeeeetttt
  283.           NNNNaaaammmmeeee                CCCCllllaaaassssssss               TTTTyyyyppppeeee          DDDDeeeeffffaaaauuuulllltttt   AAAAcccccccceeeessssssss
  284.           XmNchildren         XmCReadOnly         WidgetList    NULL      G
  285.           XmNinsertPosition   XmCInsertPosition   XtOrderProc   NULL      CSG
  286.           XmNnumChildren      XmCReadOnly         Cardinal      0         G
  287.  
  288.                                                         CCCCoooorrrreeee RRRReeeessssoooouuuurrrrcccceeee SSSSeeeetttt
  289.           NNNNaaaammmmeeee                            CCCCllllaaaassssssss                           TTTTyyyyppppeeee             DDDDeeeeffffaaaauuuulllltttt                AAAAcccccccceeeessssssss
  290.           XmNaccelerators                 XmCAccelerators                 XtAccelerators   dynamic                CSG
  291.           XmNancestorSensitive            XmCSensitive                    Boolean          dynamic                G
  292.           XmNbackground                   XmCBackground                   Pixel            dynamic                CSG
  293.           XmNbackgroundPixmap             XmCPixmap                       Pixmap           XmUNSPECIFIED_PIXMAP   CSG
  294.           XmNborderColor                  XmCBorderColor                  Pixel            XtDefaultForeground    CSG
  295.           XmNborderPixmap                 XmCPixmap                       Pixmap           XmUNSPECIFIED_PIXMAP   CSG
  296.           XmNborderWidth                  XmCBorderWidth                  Dimension        0                      CSG
  297.           XmNcolormap                     XmCColormap                     Colormap         dynamic                CG
  298.           XmNdepth                        XmCDepth                        int              dynamic                CG
  299.           XmNdestroyCallback              XmCCallback                     XtCallbackList   NULL                   C
  300.           XmNheight                       XmCHeight                       Dimension        dynamic                CSG
  301.           XmNinitialResourcesPersistent   XmCInitialResourcesPersistent   Boolean          True                   C
  302.           XmNmappedWhenManaged            XmCMappedWhenManaged            Boolean          True                   CSG
  303.           XmNscreen                       XmCScreen                       Screen *         dynamic                CG
  304.           XmNsensitive                    XmCSensitive                    Boolean          True                   CSG
  305.           XmNtranslations                 XmCTranslations                 XtTranslations   dynamic                CSG
  306.           XmNwidth                        XmCWidth                        Dimension        dynamic                CSG
  307.           XmNx                            XmCPosition                     Position         0                      CSG
  308.           XmNy                            XmCPosition                     Position         0                      CSG
  309.  
  310.         TTTTrrrraaaannnnssssllllaaaattttiiiioooonnnnssss
  311.           XmFrame inherits translations from XmManager.
  312.  
  313.      RRRREEEELLLLAAAATTTTEEEEDDDD
  314.           CCCCoooommmmppppoooossssiiiitttteeee(3), CCCCoooonnnnssssttttrrrraaaaiiiinnnntttt(3), CCCCoooorrrreeee(3), XXXXmmmmCCCCrrrreeeeaaaatttteeeeFFFFrrrraaaammmmeeee(3), and
  315.           XXXXmmmmMMMMaaaannnnaaaaggggeeeerrrr(3).
  316.  
  317.  
  318.  
  319.  
  320.  
  321.  
  322.  
  323.  
  324.  
  325.  
  326.  
  327.      Page 5                                         (printed 10/24/98)
  328.  
  329.  
  330.  
  331.